<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SC2API: SC2API Documentation</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="SC2-Logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">SC2API
   </div>
   <div id="projectbrief">An API for AI for StarCraft II</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">SC2API Documentation </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Some quick start guides have been added:</p>
<p><a href="../building.md">How to Build</a> - How to git this project, and how to build a Visual Studio solution.</p>
<p><a href="../getting_started.md">Getting Started with SC2API</a> - How to run examples.</p>
<p><a href="../tutorial1.md">Tutorial 1</a> - Create a simple bot.</p>
<p><a href="../tutorial2.md">Tutorial 2</a> - Make your bot build SCV's and Supply Depots.</p>
<hr/>
<p><b>Important Interfaces</b></p>
<p>The two most important interfaces you will use are the <a href="classsc2_1_1_observation_interface.html">ObservationInterface</a> and the <a href="classsc2_1_1_action_interface.html">ActionInterface</a> which are available to your <a href="classsc2_1_1_agent.html">Agent</a>. Get the ObservationInterface by calling <b>Observation()</b>, and the ActionInterface by calling <b>Actions()</b> from your Agent.</p>
<p>An "Agent" is your bot, capable of performing actions in a game &ndash; a player.</p>
<p>An "Observation" is a snapshot of the game's state at any given point in time, which is available at any time when a game or replay is running. The Observation Interface provides access to a list of units, including your Bot's units and enemy units that are visible to your units.</p>
<p>An "Action" is a command given to units, for example to attack, move or build a structure.</p>
<hr/>
<p><b>Important Notes</b></p>
<ul>
<li>
Structures are a type of unit, and are included when you call "GetUnits". </li>
</ul>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
